home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / amiga / hdf / hdf.lha / DF.H next >
Encoding:
C/C++ Source or Header  |  1980-02-06  |  10.9 KB  |  252 lines
  1. /*****************************************************************************
  2. * 
  3. *              NCSA HDF version 3.10r2
  4. *                Sept 20, 1990
  5. *
  6. * NCSA HDF Version 3.10r2 source code and documentation are in the public
  7. * domain.  Specifically, we give to the public domain all rights for future
  8. * licensing of the source code, all resale rights, and all publishing rights.
  9. * 
  10. * We ask, but do not require, that the following message be included in all
  11. * derived works:
  12. * 
  13. * Portions developed at the National Center for Supercomputing Applications at
  14. * the University of Illinois at Urbana-Champaign.
  15. * 
  16. * THE UNIVERSITY OF ILLINOIS GIVES NO WARRANTY, EXPRESSED OR IMPLIED, FOR THE
  17. * SOFTWARE AND/OR DOCUMENTATION PROVIDED, INCLUDING, WITHOUT LIMITATION,
  18. * WARRANTY OF MERCHANTABILITY AND WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE
  19. * 
  20. *****************************************************************************/
  21.  
  22. /*
  23. $Header: /pita/work/HDF/dev/RCS/src/df.h,v 3.2 90/05/17 17:12:32 clow beta $
  24. $Log:    df.h,v $
  25.  * Revision 3.2  90/05/17  17:12:32  clow
  26.  * removed #include <fortran.h> which has migrated to dfi.h
  27.  * 
  28. */
  29. /*-----------------------------------------------------------------------------
  30.  * File:    df.h
  31.  * Purpose: header file for HDF routines
  32.  * Invokes: dfi.h
  33.  * Contents: 
  34.  *  Structure definitions: DFddh, DFdd, DFdesc, DFdle, DF, DFdi, DFdata
  35.  *  Procedure type definitions
  36.  *  Global variables
  37.  *  Tag definitions
  38.  *  Error return codes
  39.  *  Logical constants
  40.  * Remarks: This file is included with user programs
  41.  *          Since it includes stdio.h etc., do not include these after df.h
  42.  *-----------------------------------------------------------------------*/
  43.  
  44.  
  45. #include "dfi.h"
  46.  
  47. /*-----------------------------------------------------------------------*/
  48. /*                      Type declarations                                */
  49.  
  50. typedef struct DFddh {        /*format of data descriptor headers in file*/
  51.     int16 dds;            /* number of dds in header block */
  52.     int32 next;            /* offset of next header block */
  53. } DFddh;
  54.  
  55. typedef struct DFdd {        /* format of data descriptors as in file */
  56.     uint16 tag;            /* data tag */
  57.     uint16 ref;            /* data reference number */
  58.     int32 offset;        /* offset of data element in file */
  59.     int32 length;        /* number of bytes */
  60. } DFdd;
  61.  
  62. /* descriptor structure is same as dd structure.  ###Note: may be changed */
  63. #define DFdesc DFdd
  64.  
  65. /* DLE is the internal structure which stores data descriptor information */
  66. /* It is a linked list of DDs */
  67. typedef struct DFdle {        /* Data List element */
  68.     struct DFdle *next;        /* link to next dle */
  69.     DFddh ddh;            /* To store headers */
  70.     DFdd dd[1];            /* dummy size */
  71. } DFdle;
  72.  
  73. /* DF is the internal structure associated with each DF file */
  74. /* It holds information associated with the file as a whole */
  75. /* ### Note: there are hooks for having multiple DF files open at a time */
  76. typedef struct DF {
  77.     DFdle *list;        /* Pointer to the DLE list */
  78.     DFdle *last_dle;        /* last_dle and last_dd are used in searches */
  79.                 /* to indicate element returned */
  80.                 /* by previous call to DFfind */
  81.     int type;            /* 0= not in use, 1= normal, -1 = multiple */
  82.                 /* this is a hook for when */
  83.                 /* multiple files are open */
  84.     int access;            /* permitted access types: */
  85.                 /* 0=none, 1=r, 2=w, 3=r/w */
  86.     int changed;        /* True if anything in DDs modified */
  87.                 /* since last write */
  88.     uint16 last_tag;        /* Last tag searched for by DFfind */
  89.     uint16 last_ref;        /* Last reference number searched for */
  90.     int last_dd;        /* see last_dle */
  91.     int defdds;            /* default numer of DD's in each block */
  92.     int up_access;        /* access permissions to element being */
  93.                 /* read/updated. Used by DFstart */
  94.     DFdd *up_dd;        /* DD of element being read/updated, */
  95.                 /* used by DFstart */
  96.     /* file handle is a file pointer or file descriptor depending on whether */
  97.     /* we use buffered or unbuffered i/o */
  98. #ifdef DF_BUFFIO
  99.     FILE *file;            /* file pointer */
  100. #else /*DF_BUFFIO*/
  101.     int file;            /* file descriptor */
  102. #endif /*DF_BUFFIO*/
  103. } DF;
  104.  
  105.  
  106. typedef struct DFdi {   /* data identifier: specifies data element uniquely */
  107.     uint16 tag;
  108.     uint16 ref;
  109. } DFdi;
  110.  
  111.  
  112.  
  113. typedef struct DFdata { /* structure for returning status information */
  114.     int version;        /* version number of program */
  115. } DFdata;
  116.  
  117. /*--------------------------------------------------------------------------*/
  118. /*                          Procedure types                                 */
  119. #include "dfproto.h"
  120.  
  121. /*--------------------------------------------------------------------------*/
  122. /*                          Global Variables                                */
  123.  
  124. #ifndef DFMASTER
  125. extern
  126. #endif /*DFMASTER*/
  127. int DFerror;            /* Error code for DF routines */
  128.  
  129. /*--------------------------------------------------------------------------*/
  130. /*                           Tag Definitions                                */
  131.  
  132. #define DFREF_WILDCARD ((uint16)0) /* wildcard ref for searches */
  133.  
  134. #define DFTAG_WILDCARD ((uint16)0) /* wildcard tag for searches */
  135. #define DFTAG_NULL  ((uint16)1)    /* empty DD */
  136.  
  137. /* utility set */
  138. #define DFTAG_FID   ((uint16)100) /* File identifier */
  139. #define DFTAG_FD    ((uint16)101) /* File description */
  140. #define DFTAG_TID   ((uint16)102) /* Tag identifier */
  141. #define DFTAG_TD    ((uint16)103) /* Tag descriptor */
  142. #define DFTAG_DIL   ((uint16)104) /* data identifier label */
  143. #define DFTAG_DIA   ((uint16)105) /* data identifier annotation */
  144. #define DFTAG_NT    ((uint16)106) /* number type */
  145. #define DFTAG_MT    ((uint16)107) /* machine type */
  146.  
  147. /* raster-8 set */
  148. #define DFTAG_ID8   ((uint16)200) /* 8-bit Image dimension */
  149. #define DFTAG_IP8   ((uint16)201) /* 8-bit Image palette */
  150. #define DFTAG_RI8   ((uint16)202) /* Raster-8 image */
  151. #define DFTAG_CI8   ((uint16)203) /* RLE compressed 8-bit image */
  152. #define DFTAG_II8   ((uint16)204) /* IMCOMP compressed 8-bit image */
  153.  
  154. /* Raster Image set */
  155. #define DFTAG_ID    ((uint16)300) /* Image DimRec */
  156. #define DFTAG_LUT   ((uint16)301) /* Image Palette */
  157. #define DFTAG_RI    ((uint16)302) /* Raster Image */
  158. #define DFTAG_CI    ((uint16)303) /* Compressed Image */
  159.  
  160. #define DFTAG_RIG   ((uint16)306) /* Raster Image Group */
  161. #define DFTAG_LD    ((uint16)307) /* Palette DimRec */
  162. #define DFTAG_MD    ((uint16)308) /* Matte DimRec */
  163. #define DFTAG_MA    ((uint16)309) /* Matte Data */
  164. #define DFTAG_CCN   ((uint16)310) /* color correction */
  165. #define DFTAG_CFM   ((uint16)311) /* color format */
  166. #define DFTAG_AR    ((uint16)312) /* aspect ratio */
  167.  
  168. #define DFTAG_DRAW  ((uint16)400) /* Draw these images in sequence */
  169. #define DFTAG_RUN   ((uint16)401) /* run this as a program/script */
  170.  
  171. #define DFTAG_XYP   ((uint16)500) /* x-y position */
  172. #define DFTAG_MTO   ((uint16)501) /* machine-type override */
  173.  
  174. /* Tektronix */
  175. #define DFTAG_T14   ((uint16)602) /* TEK 4014 data */
  176. #define DFTAG_T105  ((uint16)603) /* TEK 4105 data */
  177.  
  178. /* Scientific Data set */
  179. #define DFTAG_SDG   ((uint16)700) /* Scientific Data Group */
  180. #define DFTAG_SDD   ((uint16)701) /* Scientific Data DimRec */
  181. #define DFTAG_SD    ((uint16)702) /* Scientific Data */
  182. #define DFTAG_SDS   ((uint16)703) /* Scales */
  183. #define DFTAG_SDL   ((uint16)704) /* Labels */
  184. #define DFTAG_SDU   ((uint16)705) /* Units */
  185. #define DFTAG_SDF   ((uint16)706) /* Formats */
  186. #define DFTAG_SDM   ((uint16)707) /* Max/Min */
  187. #define DFTAG_SDC   ((uint16)708) /* Coord sys */
  188. #define DFTAG_SDT   ((uint16)709) /* Transpose */
  189.  
  190. /* compression schemes */
  191. #define DFTAG_RLE   ((uint16)11) /* run length encoding */
  192. #define DFTAG_IMC   ((uint16)12) /* IMCOMP compression */
  193.  
  194. /*--------------------------------------------------------------------------*/
  195. /*                          Error Return Codes                              */
  196.  
  197. #define DFE_NOERROR     0   /* No error */
  198. #define DFE_FNF         -1  /* File not found error */
  199. #define DFE_DENIED      -2  /* Access to file denied */
  200. #define DFE_ALROPEN     -3  /* File already open */
  201. #define DFE_TOOMANY     -4  /* Too Many DF's or files open */
  202. #define DFE_BADNAME     -5  /* Bad file name on open */
  203. #define DFE_BADACC      -6  /* Bad file access mode */
  204. #define DFE_BADOPEN     -7  /* Other open error */
  205. #define DFE_NOTOPEN     -8  /* File can't be closed 'cause it isn't open */
  206. #define DFE_CANTCLOSE   -9  /* fclose wouldn't work! */
  207. #define DFE_DFNULL      -10 /* DF is a null pointer */
  208. #define DFE_ILLTYPE     -11 /* DF has an illegal type: internal error */
  209. #define DFE_UNSUPPORTED -12 /* Feature not currently supported */
  210. #define DFE_BADDDLIST   -13 /* The DD list is non-existent: internal error */
  211. #define DFE_NOTDFFILE   -14 /* This is not a DF file and it is not 0 length */
  212. #define DFE_SEEDTWICE   -15 /* The DD list already seeded: internal error */
  213. #define DFE_NOSPACE     -16 /* Malloc failed */
  214. #define DFE_NOSUCHTAG   -17 /* There is no such tag in the file: search failed*/
  215. #define DFE_READERROR   -18 /* There was a read error */
  216. #define DFE_WRITEERROR  -19 /* There was a write error */
  217. #define DFE_SEEKERROR   -20 /* There was a seek error */
  218. #define DFE_NOFREEDD    -21 /* There are no free DD's left: internal error */
  219. #define DFE_BADTAG      -22 /* illegal WILDCARD tag */
  220. #define DFE_BADREF      -23 /* illegal WILDCARD reference # */
  221. #define DFE_RDONLY      -24 /* The DF is read only */
  222. #define DFE_BADCALL     -25 /* Calls in wrong order */
  223. #define DFE_BADPTR      -26 /* NULL ptr argument */
  224. #define DFE_BADLEN      -27 /* negative len specified */
  225. #define DFE_BADSEEK     -28 /* Attempt to seek past end of element */
  226. #define DFE_NOMATCH     -29 /* No (more) DDs which match specified tag/ref */
  227. #define DFE_NOTINSET    -30 /* Warning: Set contained unknown tag: ignored */
  228. #define DFE_BADDIM      -31 /* negative or zero dimensions specified */
  229. #define DFE_BADOFFSET   -32 /* Illegal offset specified */
  230. #define DFE_BADSCHEME   -33 /* Unknown compression scheme specified */
  231. #define DFE_NODIM       -34 /* No dimension record associated with image */
  232. #define DFE_NOTENOUGH   -35 /* space provided insufficient for size of data */
  233. #define DFE_NOVALS      -36 /* Values not available */
  234. #define DFE_CORRUPT     -37 /* File is corrupted */
  235. #define DFE_BADCONV     -37 /* Don't know how to convert data type */
  236. #define DFE_BADFP       -38 /* The file contained an illegal floating point no*/
  237. #define DFE_NOREF       -39 /* no more reference numbers are available */
  238. #define DFE_BADDATATYPE -40 /* unknown or unavailable data type specified */
  239. #define DFE_BADMCTYPE   -41 /* unknown or unavailable machine type specified */
  240. #define DFE_BADNUMTYPE  -42 /* unknown or unavailable number type specified */
  241. #define DFE_BADORDER    -43 /* unknown or illegal array order specified */
  242. #define DFE_NOTIMPL     -44 /* This feature not yet implemented */
  243.  
  244. /*--------------------------------------------------------------------------*/
  245. /*                          Logical Constants                               */
  246.  
  247. #define DFACC_READ      1   /* Read Access */
  248. #define DFACC_WRITE     2   /* Write Access */
  249. #define DFACC_CREATE    4   /* force file to be created */
  250. #define DFACC_ALL       7   /* the logical and of all the above values */
  251.  
  252.